vcGeometryContainer

vcGeometryContainer is a container used to store all types of geometry sets for nodes and Geometry features.

See in: Overview

Module: vcGeometry

Parent: vcObject

Children -

Referenced by: vc3DIcon.Geometry, vcGeometryFeature.Geometry, vcGeometrySet.Container, vcNode.Geometry, ... (see more)
vc3DIcon.Geometry
vcGeometryFeature.Geometry
vcGeometrySet.Container
vcNode.Geometry
vcNode.UserGeometry

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
BoundingBoxvcBoundingBoxRGets an axis-aligned bounding box.
GeometrySetCountIntegerRGets the amount of geometry sets in the container.
GeometrySetsvcList[vcGeometrySet]RGets a list of geometry sets in the container.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
clearNoneNoneRemoves all geometry sets from the container.
cloneGeometrySetsNonevcGeometryContainer geometryContainer,
Optional Keyword[offset = vcMatrix]
Copies all geometry sets in the container to a given container. An optional offset argument can be given to offset the copied geometry, thereby making it easier to distinguish the original from its copy. In this case, geometry is shared between both containers.
See more
Parameters:
container (vcGeometryContainer) : Copy target, offset (vcMatrix): Offset to use when copying.

Exceptions:
LicenseError: No license for Modeling API.
createGeometrySetvcObjectvcGeometrySetType argCreates a new geometry set of a given type in the container. See Geometry Constants for more information.
See more
Parameters:
type (Enumeration): The type of geometry set to create.

Exceptions:
LicenseError: No license for Modeling API.
ValueError: Unsupported geometry set type.

Returns:
vcGeometrySet
getGeometrySetvcGeometrySetInteger indexGets a geometry set at a given index in the container.
See more
Parameters:
index (int): The index of the geometry set to retrieve.

Exceptions:
IndexError: Index out of bounds.

Returns:
GeometrySet (vcGeometrySet): The geometry set at the specified index.
moveGeometrySetsNonevcGeometryContainer targetContainer,
Optional Keyword[offset = vcMatrix]
Moves all geometry sets in the container to a given container.
See more
Parameters:
targetContainer (vcGeometryContainer): The target container to move the geometry sets to.
offset (vcMatrix): An optional offset argument to apply to the moved geometry.

Exceptions:
LicenseError: No license for Modeling API.
setModifiedNoneNoneMarks the geometry of the container as modified, thereby alerting the application that changes need to be saved to file.
transformContentNonevcMatrix matrixTransforms all geometry sets of the container by the given matrix.

Parameters:
matrix (vcMatrix): The transformation matrix to apply.
updateNoneNoneUpdates the bound box of container.